GET api/properties/{propertyId}/packages?status[0]={status[0]}&status[1]={status[1]}&source={source}&sort={sort}&page={page}&pageSize={pageSize}

Get all packages for a property.

Request Information

Authentication

This method requires user authentication

URI Parameters

Name	Description	Type	Additional information
propertyId	(Required)	integer	Required
status	(Optional) Limits the results by status. If no status filter is applied all packages are retuned. The possible values can be found in api/packages/statuses. By default will return all packages where the status is undelivered (See in api/packages/statuses the statuses where the status has the property IsDeliveredStatus = false).	Collection of string	None.
source	(Optional)Limits the results by source = unitnumber.	string
sort	(Optional)The order in which to sort the returned packages. Defaults to packagedate descending. The possible values are: unitdisplayorder and packagedate	string
page	(Optional)The page number of returned records based on the page size	integer	0
pageSize	(Optional)The number of records to return per page	integer	0

Body Parameters

None.

Response Information

Resource Description

ListWrapperOfPackageTracking

Name	Description	Type	Additional information
Total		integer	None.
Elements		Collection of PackageTracking	None.

Response Formats

application/json, text/json

Sample:

{
  "Total": 1,
  "Elements": [
    {
      "PackageId": 1,
      "PropertyId": 2,
      "UnitId": 1,
      "ResidentId": 1,
      "Sender": "sample string 3",
      "SenderAddress1": "sample string 4",
      "SenderAddress2": "sample string 5",
      "SenderCity": "sample string 6",
      "SenderState": "sample string 7",
      "SenderZip": "sample string 8",
      "Details": "sample string 9",
      "Status": "sample string 10",
      "Type": "sample string 11",
      "PackageCreated": "2025-12-24T05:28:28.0266607-05:00",
      "PickedUpBy": "sample string 12",
      "PickedUpOn": "sample string 13",
      "TrackingNumber": "sample string 14",
      "Shipper": "sample string 15",
      "CreatedBy": 1,
      "CreatedOn": "2025-12-24T05:28:28.0266607-05:00",
      "LastModifiedBy": 1,
      "LastModifiedOn": "2025-12-24T05:28:28.0266607-05:00",
      "ReceivingSigFilePath": "sample string 16",
      "ReceivingSigFileDate": "2025-12-24T05:28:28.0266607-05:00",
      "FrontDeskSigFilePath": "sample string 17",
      "FrontDeskSigFileDate": "2025-12-24T05:28:28.0266607-05:00",
      "ValetSigFilePath": "sample string 18",
      "ValetSigFileDate": "2025-12-24T05:28:28.0266607-05:00",
      "ResidentSigFilePath": "sample string 19",
      "ResidentSigFileDate": "2025-12-24T05:28:28.0266607-05:00"
    },
    {
      "PackageId": 1,
      "PropertyId": 2,
      "UnitId": 1,
      "ResidentId": 1,
      "Sender": "sample string 3",
      "SenderAddress1": "sample string 4",
      "SenderAddress2": "sample string 5",
      "SenderCity": "sample string 6",
      "SenderState": "sample string 7",
      "SenderZip": "sample string 8",
      "Details": "sample string 9",
      "Status": "sample string 10",
      "Type": "sample string 11",
      "PackageCreated": "2025-12-24T05:28:28.0266607-05:00",
      "PickedUpBy": "sample string 12",
      "PickedUpOn": "sample string 13",
      "TrackingNumber": "sample string 14",
      "Shipper": "sample string 15",
      "CreatedBy": 1,
      "CreatedOn": "2025-12-24T05:28:28.0266607-05:00",
      "LastModifiedBy": 1,
      "LastModifiedOn": "2025-12-24T05:28:28.0266607-05:00",
      "ReceivingSigFilePath": "sample string 16",
      "ReceivingSigFileDate": "2025-12-24T05:28:28.0266607-05:00",
      "FrontDeskSigFilePath": "sample string 17",
      "FrontDeskSigFileDate": "2025-12-24T05:28:28.0266607-05:00",
      "ValetSigFilePath": "sample string 18",
      "ValetSigFileDate": "2025-12-24T05:28:28.0266607-05:00",
      "ResidentSigFilePath": "sample string 19",
      "ResidentSigFileDate": "2025-12-24T05:28:28.0266607-05:00"
    }
  ]
}

Internal Error Codes

106: ResourceNotFound
(The requested resource was not found., NotFound)
100: MissingRequiredHeader
(Invalid request format. A required HTTP header was not specified., BadRequest)
118: InvalidHeaderValue
(The value provided for one of the HTTP headers was not in the correct format., BadRequest)
199: UnknownError
(Internal server error., InternalServerError)
105: ResourceNotLinkedToUser
(User is trying to access a resource that belongs to a property not linked to the user., Forbidden)